home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Frameworks / Extension Shell 1.4 / Extension Shell 1.4 (Source) / InstallCode.c < prev    next >
Text File  |  1995-11-03  |  13KB  |  545 lines
  1. /*    NAME:
  2.         InstallCode.c
  3.  
  4.     WRITTEN BY:
  5.         Dair Grant
  6.                 
  7.     DESCRIPTION:
  8.         Routines for installing various code resources.
  9.         
  10.     ___________________________________________________________________________
  11. */
  12. //=============================================================================
  13. //        Include files                                                                     
  14. //-----------------------------------------------------------------------------
  15. #include <Memory.h>
  16. #include <Gestalt.h>
  17. #include <Shutdown.h>
  18. #include <Timer.h>
  19. #include "ES.h"
  20. #include "ES Address Table.h"
  21. #include "InstallCode.h"
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37. //=============================================================================
  38. //        Private function prototypes                                                                     
  39. //-----------------------------------------------------------------------------
  40. OSErr    InstallTrapPatch(short i, Ptr theCode);
  41. OSErr    InstallGestaltSelector(short i, Ptr theCode);
  42. OSErr    InstallShutdownTask(short i, Ptr theCode);
  43. OSErr    InstallVBLTask(short i, Ptr theCode);
  44. OSErr    InstallLowMemFilter(short i, Ptr theCode);
  45. OSErr    InstallCodeBlock(short i, Ptr theCode);
  46. OSErr    InstallTimeManagerTask(short i, Ptr theCode);
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62. //=============================================================================
  63. //        Global variables                                                                 
  64. //-----------------------------------------------------------------------------
  65. extern ESParamBlock            gTheParamBlock;
  66. extern ESAddressTable        *gTheESAddressTable;
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82. //=============================================================================
  83. //        InstallCode : Install a code resource depending on its type.                                                                 
  84. //-----------------------------------------------------------------------------
  85. //        Note :    We get the index of something in gTheParamBlock.theCodeResources
  86. //                and case out on its type to do the installation. If any error
  87. //                occurs, we return the error code - our caller fills in the
  88. //                details in gTheParamBlock.
  89. //-----------------------------------------------------------------------------
  90. OSErr InstallCode(short i)
  91. {    Handle        theHnd;
  92.     OSErr        theErr;
  93.     Ptr            theCode;
  94.     
  95.     
  96.  
  97.  
  98.     // Get the code resource we're after, and return if it wasn't there.
  99.     theHnd = GetResource(gTheParamBlock.theCodeResources[i].resType,
  100.                          gTheParamBlock.theCodeResources[i].resID);
  101.     if (theHnd == nil)
  102.         return(resNotFound);
  103.  
  104.  
  105.     
  106.     // Unlock the resource, compact the heap, then lock it down. We then
  107.     // detach it so it stays around after Extension Shell is gone.
  108.     HUnlock(theHnd);
  109.     ResrvMem(GetHandleSize(theHnd));
  110.     HLock(theHnd);
  111.     DetachResource(theHnd);
  112.  
  113.  
  114.  
  115.     // Get a clean address from the handle
  116.     theCode = (Ptr) StripAddress(*theHnd);
  117.  
  118.  
  119.  
  120.     // Now case out on the type of the code, and call the install routine
  121.     switch(gTheParamBlock.theCodeResources[i].codeType) {
  122.         case kTrapPatchType:
  123.              theErr = InstallTrapPatch(i, theCode);
  124.              break;
  125.              
  126.         case kGestaltSelectorType:
  127.              theErr = InstallGestaltSelector(i, theCode);
  128.              break;
  129.              
  130.         case kShutdownTaskType:
  131.              theErr = InstallShutdownTask(i, theCode);
  132.              break;
  133.              
  134.         case kVBLTaskType:
  135.              theErr = InstallVBLTask(i, theCode);
  136.              break;
  137.         
  138.         case kLowMemFilterType:
  139.              theErr = InstallLowMemFilter(i, theCode);
  140.              break;
  141.         
  142.         case kCodeBlockType:
  143.              theErr = InstallCodeBlock(i, theCode);
  144.              break;
  145.         
  146.         case kTimeManagerTaskType:
  147.              theErr = InstallTimeManagerTask(i, theCode);
  148.              break;
  149.         
  150.         default:
  151.              theErr = noErr;
  152.     }
  153.  
  154.     
  155.     // Return any errors that occurred    
  156.     return(theErr);
  157. } 
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173. //=============================================================================
  174. //        InstallESAddressTable : Install an address table.
  175. //-----------------------------------------------------------------------------
  176. //        Note :    We install the Gestalt selector, call Gestalt to obtain the
  177. //                address of the address table, and leave the result in
  178. //                gTheESAddressTable.
  179. //
  180. //                Because the address table is so fundamental, any failure
  181. //                to load, install, or call it drops us into MacsBug.
  182. //-----------------------------------------------------------------------------
  183. void InstallESAddressTable(void)
  184. {    Handle            theHnd;
  185.     OSErr            theErr;
  186.     ProcPtr            theCode;    
  187.  
  188.  
  189.  
  190.     // Load the AddressTable Gestalt selector, and install it with NewGestalt.
  191.     theHnd = GetResource(kAddrsTableCodeType, kAddrsTableCodeID);
  192.     if (theHnd == nil)
  193.         DebugStr("\pExtension Shell - couldn't find Address Table resource");
  194.     
  195.     
  196.     // We have it, so lock it in place
  197.     HUnlock(theHnd);
  198.     ResrvMem(GetHandleSize(theHnd));
  199.     HLock(theHnd);
  200.     DetachResource(theHnd);
  201.     
  202.     
  203.     // Get a clean address from the handle
  204.     theCode = (ProcPtr) StripAddress(*theHnd);
  205.     
  206.     
  207.     // Install the address table as a Gestalt selector
  208.     theErr = NewGestalt(gTheParamBlock.addressTableSelector,
  209.                                 NewSelectorFunctionProc(theCode));
  210.     if (theErr != noErr)
  211.         DebugStr("\pExtension Shell - couldn't install AddressTable");
  212.         
  213.  
  214.     // Call Gestalt to get the address of the address table
  215.     theErr = Gestalt(gTheParamBlock.addressTableSelector, (long *) &gTheESAddressTable);
  216.     if (theErr != noErr)
  217.         DebugStr("\pExtension Shell - couldn't call AddressTable");
  218. }
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234. //=============================================================================
  235. //        InstallTrapPatch : Install a trap patch.                                                         
  236. //-----------------------------------------------------------------------------
  237. //        Note :    Given a trap word and a pointer to the new routine, we save
  238. //                the original entry in the dispatch table and insert the new
  239. //                one.
  240. //
  241. //                We assume that the trap *is* implemented. If globalPatch is
  242. //                true, the patch is applied to all applications (this is the
  243. //                default behaviour). If globalPatch is false, the patch only
  244. //                takes affect in the application appName. (THIS FEATURE IS
  245. //                NOT IMPLEMENTED YET)
  246. //-----------------------------------------------------------------------------
  247. OSErr InstallTrapPatch(short i, Ptr theCode)
  248. {    short        trapWord;
  249.     TrapType    trapType;
  250.     ProcPtr        oldCodeAddress;
  251.     
  252.     
  253.     
  254.     // Find out what we need to know
  255.      trapWord = gTheParamBlock.theCodeResources[i].theCodeThing.theTrapPatch.trapWord;
  256.     trapType = (trapWord & 0x0800) ? ToolTrap : OSTrap;
  257.  
  258.  
  259.     // Replace the old value in the dispatch table with the new value.
  260.     oldCodeAddress = (ProcPtr) StripAddress((Ptr) NGetTrapAddress(trapWord, trapType));
  261.     NSetTrapAddress((UniversalProcPtr) theCode, trapWord, trapType);
  262.     
  263.     
  264.     
  265.     // Handle globalPatch and appName
  266.     //
  267.     // THIS FEATURE IS NOT IMPLEMENTED YET - IT WOULD NEED SOME KIND OF
  268.     // GENERIC EXTENSION SHELL PATCH TO SOMETHING LIKE _INITALLPACKS OR
  269.     // _INITGRAF, AND THEN THE APPLICATION OF PATCHES DEPENDING ON
  270.     // THE APPLICATION BEING EXECUTED.
  271.     //
  272.     //
  273.     
  274.     
  275.     
  276.     // Fill in the entry in the address table and save the address of the new code.
  277.     gTheESAddressTable->theTable[i]                    = oldCodeAddress;
  278.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  279.  
  280.  
  281.     // Return any errors
  282.     return(noErr);
  283. }
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299. //=============================================================================
  300. //        InstallGestaltSelector : Install a Gestalt Selector.                                                         
  301. //-----------------------------------------------------------------------------
  302. OSErr InstallGestaltSelector(short i, Ptr theCode)
  303. {    OSErr                    theErr;
  304.     SelectorFunctionUPP        theUPP;
  305.     AGestaltSelector        *theGestaltInfo;
  306.  
  307.  
  308.  
  309.  
  310.     // Find out what we need to know
  311.     theGestaltInfo = &gTheParamBlock.theCodeResources[i].theCodeThing.theGestaltSelector;
  312.     theUPP = NewSelectorFunctionProc(theCode);
  313.     
  314.  
  315.     
  316.     // Try and install the routine
  317.     theErr = NewGestalt(theGestaltInfo->theSelector, theUPP);
  318.  
  319.     
  320.     
  321.     // If the selector exists, replace it if we're allowed to, and save
  322.     // the address of the old routine in the address table
  323.     if (theErr == gestaltDupSelectorErr && theGestaltInfo->overwriteExistingSelector)
  324.         theErr = ReplaceGestalt(theGestaltInfo->theSelector, theUPP,
  325.                                 (SelectorFunctionUPP *) &gTheESAddressTable->theTable[i]);
  326.     
  327.     
  328.     
  329.     // If there wasn't a problem, save the address of the new code. The address
  330.     // table is only used if we need to get access to the old Gestalt routine.
  331.     if (theErr == noErr)
  332.         gTheParamBlock.theCodeResources[i].theAddress = theCode;
  333.         
  334.         
  335.     
  336.     // Return any errors
  337.     return(theErr);
  338. }
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354. //=============================================================================
  355. //        InstallShutdownTask : Install a Shutdown Task.                                                         
  356. //-----------------------------------------------------------------------------
  357. OSErr InstallShutdownTask(short i, Ptr theCode)
  358. {
  359.  
  360.  
  361.     // Install the task with its flags and save the address in gTheParamBlock.
  362.     // We don't use the address table at all.
  363.     ShutDwnInstall(NewShutDwnProc(theCode),
  364.                    gTheParamBlock.theCodeResources[i].theCodeThing.theShutdownTask.theFlags);
  365.     gTheParamBlock.theCodeResources[i].theAddress = theCode;
  366.  
  367.  
  368.     // Return any errors
  369.     return(noErr);
  370. }
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386. //=============================================================================
  387. //        InstallVBLTask : Install a VBL task.                                                         
  388. //-----------------------------------------------------------------------------
  389. OSErr InstallVBLTask(short i, Ptr theCode)
  390. {    VBLTask         *theVblPtr;
  391.     OSErr            theErr;
  392.     
  393.     
  394.     
  395.     
  396.     // Allocate a little block of memory in the System Heap for the task information
  397.     theVblPtr = (VBLTask*) NewPtrSys(sizeof(VBLTask));
  398.     
  399.     
  400.     
  401.     // Fill in the fields, and install it as a VBL task
  402.     theVblPtr->qType    = vType;
  403.     theVblPtr->vblAddr  = NewVBLProc(theCode);
  404.     theVblPtr->vblCount = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblCount;
  405.     theVblPtr->vblPhase = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblPhase;
  406.     theErr = VInstall((QElemPtr) theVblPtr);
  407.     
  408.     
  409.     
  410.     // Save the address of the VBLTask structure in the address table and the param block
  411.     if (theErr == noErr)
  412.         {
  413.         gTheESAddressTable->theTable[i]                    = (ProcPtr) theVblPtr;
  414.         gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theVblPtr;
  415.         }
  416.     
  417.     
  418.     // Return any errors
  419.     return(theErr);
  420. }
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436. //=============================================================================
  437. //        InstallLowMemFilter : Install a low-memory filter.                                                         
  438. //-----------------------------------------------------------------------------
  439. OSErr InstallLowMemFilter(short i, Ptr theCode)
  440. {    ProcPtr        theEntryPoint;
  441.     
  442.  
  443.  
  444.     
  445.     // Get the address of the filter chain.
  446.     theEntryPoint = (ProcPtr) gTheParamBlock.theCodeResources[i].theCodeThing.theLowMemFilter.theEntryPoint;
  447.     
  448.     
  449.     
  450.     // Save the address currently at the front of the chain in the address table
  451.     // and save ourselves in the param block.
  452.     gTheESAddressTable->theTable[i]                    = (ProcPtr) *((void **) theEntryPoint);
  453.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  454.     
  455.     
  456.     // Insert ourselves into the front of the chain
  457.     *((long *) theEntryPoint) = (long) theCode;
  458.  
  459.  
  460.     // Return any errors
  461.     return(noErr);
  462. }
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478. //=============================================================================
  479. //        InstallCodeBlock : Install a block of code.                                                         
  480. //-----------------------------------------------------------------------------
  481. OSErr InstallCodeBlock(short i, Ptr theCode)
  482. {    
  483.     
  484.     // Set the reserved field to some value
  485.     gTheParamBlock.theCodeResources[i].theCodeThing.theCodeBlock.refCon = 0xDEADBEEF;
  486.     
  487.     
  488.     
  489.     // Save the address of the code block in the address table and the param block
  490.     gTheESAddressTable->theTable[i]                    = (ProcPtr) theCode;
  491.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  492.  
  493.  
  494.     // Return any errors
  495.     return(noErr);
  496. }
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512. //=============================================================================
  513. //        InstallTimeManagerTask : Install a Time Manager task.                                                         
  514. //-----------------------------------------------------------------------------
  515. OSErr InstallTimeManagerTask(short i, Ptr theCode)
  516. {    TMTask             *theTaskPtr;
  517.  
  518.  
  519.  
  520.  
  521.     // Allocate a little block of memory in the System Heap for the task information
  522.     theTaskPtr = (TMTask*) NewPtrSys(sizeof(TMTask));
  523.     
  524.     
  525.     
  526.     // Fill in the fields, and install it as an Time Manager task. We don't install
  527.     // it as with InsXTime because we probably won't need that accurate timing.
  528.     theTaskPtr->tmAddr    = (TimerUPP) theCode;
  529.     theTaskPtr->tmCount    = 0;
  530.     InsTime((QElemPtr) theTaskPtr);
  531.     PrimeTime((QElemPtr) theTaskPtr,
  532.                 gTheParamBlock.theCodeResources[i].theCodeThing.theTimeManagerTask.theDelay);
  533.     
  534.     
  535.     
  536.     // Save the address of the TMTask structure in the address table and the param block
  537.     gTheESAddressTable->theTable[i]                    = (ProcPtr) theTaskPtr;
  538.     gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theTaskPtr;
  539.     
  540.     
  541.     
  542.     // Return any errors
  543.     return(noErr);
  544. }
  545.